Skip to content

set up next.js app and static build #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 27 commits into from
May 30, 2025
Merged

set up next.js app and static build #157

merged 27 commits into from
May 30, 2025

Conversation

DaltheCow
Copy link
Contributor

This is a starter next.js app set up for static builds (static site generation comes from output: 'export' in the next.config.ts). It uses the 'use client' directive to tell Next.js to treat everything as client side code in the page.tsx file meaning that most of the app won't be prerendered. This mirrors our set up since we use MUI theming and CSS in JS which require most of the app to be client code.

@DaltheCow DaltheCow added the UI Front-end workstream label May 9, 2025

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/14936655201/artifacts/3096583956.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/14937188832/artifacts/3096779866.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/14984151213/artifacts/3110201004.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15000849591/artifacts/3115813534.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15000907321/artifacts/3115835217.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15001105889/artifacts/3115907232.
They will be retained for up to 30 days.

Copy link
Collaborator

@sjmonson sjmonson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good but needs linting fixes

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15145445766/artifacts/3162717842.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15146116872/artifacts/3162967840.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15167771656/artifacts/3170406715.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15168088586/artifacts/3170525330.
They will be retained for up to 30 days.

@DaltheCow DaltheCow force-pushed the implement-base-ui-app branch from 3c4bfe8 to c23c674 Compare May 21, 2025 17:50

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15169105051/artifacts/3170914416.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15173995155/artifacts/3172790655.
They will be retained for up to 30 days.

@markurtz markurtz requested review from markurtz and Copilot May 29, 2025 10:32
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR bootstraps a new Next.js app configured for static export, with client-side rendering via the "use client" directive to support MUI theming and CSS-in-JS.

  • Adds TypeScript configuration and path aliases
  • Introduces basic layout.tsx, page.tsx, global and module CSS for styling
  • Sets up next.config.ts for static export, ESLint config, and project metadata (package.json, README, .gitignore)

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
ui/tsconfig.json TS compiler options for Next.js + path aliases
ui/next.config.ts output: "export" for static site generation
ui/src/app/layout.tsx Root layout with Google fonts and metadata
ui/src/app/globals.css Global CSS variables and base styles
ui/src/app/page.tsx Client-side page component with images and CTAs
ui/src/app/page.module.css Scoped styles for page layout and theming
ui/package.json Project name, scripts, dependencies
ui/README.md Setup and usage instructions
ui/.gitignore Standard ignores for node, Next.js, env files
ui/.eslintrc.json ESLint setup for TS and Next.js
Comments suppressed due to low confidence (1)

ui/package.json:2

  • [nitpick] The project name "guidellm" is unclear—consider renaming it to something more descriptive or aligned with the repo purpose.
"name": "guidellm",

Copy link
Member

@markurtz markurtz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looking good. Left a few comments. Additionally, can we move the UI folder under src to keep everything for code in a central place? Specifically:
src/ui/...
src/guidellm/...

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15322267065/artifacts/3219969471.
They will be retained for up to 30 days.

DaltheCow and others added 3 commits May 29, 2025 18:13

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15334653049/artifacts/3224577202.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15334657918/artifacts/3224579023.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15334661526/artifacts/3224579740.
They will be retained for up to 30 days.

@DaltheCow
Copy link
Contributor Author

Just a note here, but I'm looking into moving all of these things around. Namely, package.json, tsconfig.json and .eslintrc.json. Thinking about next.config.ts as well. Mostly just trying to figure out big picture which things would be better off living in the root and which things are better of staying nested in src/ui.

Due to Next.js being a framework and having certain expectations, it appears that we can't be too freeform, but it looks very possible to move package.json/package-lock.json to the root and then tsconfig.json and .eslintrc.json and other future configs we will add are optional and I don't know if there is an explicit benefit to moving them out of src/ui. But also I think it is fine to and expresses the intentions of the repo a bit better.

Next.js looks for things in certain places and I haven't yet figured out if next.config.ts should be moved to the root or not. You didn't request it, but I'm just trying to think all of this through for what makes sense. Regardless this will all work and is a little more complicated than I expected for a simple thing.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15351560626/artifacts/3230153064.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15351730872/artifacts/3230219186.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15351942309/artifacts/3230299384.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15352224026/artifacts/3230402499.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15352271695/artifacts/3230418555.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15353729832/artifacts/3230973837.
They will be retained for up to 30 days.

📦 Build Artifacts Available
The build artifacts (.whl and .tar.gz) have been successfully generated and are available for download: https://github.com/neuralmagic/guidellm/actions/runs/15353744212/artifacts/3230980480.
They will be retained for up to 30 days.

@markurtz markurtz merged commit 9e31dfe into main May 30, 2025
10 checks passed
@markurtz markurtz deleted the implement-base-ui-app branch May 30, 2025 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
UI Front-end workstream
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants